home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 096 / arcdoor.arc / ARCDOOR.DOC < prev    next >
Encoding:
Text File  |  1986-10-18  |  20.1 KB  |  479 lines
  1.  
  2.  
  3.                                       *
  4.  
  5.                             *   ArcDoor v1.00   *
  6.  
  7.                                       *
  8.  
  9.  
  10.                    ----------------------------------------
  11.                           Written by : Mark Cagley
  12.                               ( With : John Gefaell )
  13.                    ----------------------------------------
  14.                         Copyright (C) 1986 Mark Cagley
  15.                    ----------------------------------------
  16.                         Documentation and Installation
  17.                    ----------------------------------------
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24. ----------------------------------------------------------------------------
  25.    Section [A]                 Introduction                 ArcDoor v1.00
  26. ----------------------------------------------------------------------------
  27.  
  28.  
  29.                     (1)   User Supported Software
  30.                           -----------------------
  31.  
  32.          User supported software is a way of delivering quality software to
  33.     the user at a reasonable cost, while allowing the user to make sure the
  34.     software meets his needs.  The user is able to try out the software
  35.     before he pays for it, insuring that it meets his requirements and
  36.     lives up to his expectations.
  37.  
  38.          The copying of the program is encouraged, and even though ArcDoor
  39.     can only be used by SysOps of a PCBoard Bulletin Board System, it can
  40.     be spread far more easily through user copying than software
  41.     distributed by regular means.
  42.  
  43.          Under the user supported software concept, a user may receive a
  44.     copy of a program from any Bulletin Board System which has a copy
  45.     available for downloading.  Usually, the program will be in ARChive
  46.     format, which means all files relating to the program are compressed
  47.     and made into a single file.  Included in this ARChive will be a notice
  48.     asking for a donation if the software meets the needs of the user.
  49.     Registration is obligatory for ArcDoor, after a period of time to
  50.     ensure that the program suits your needs. (Two weeks suggested)
  51.     Registration is the user's way of supporting the author's work.  If the
  52.     program does NOT suit a user's needs, he should discontinue its use.
  53.  
  54.          Above all, whether or not you register, copy this program and
  55.     distribute it to others for their non-commercial use.  It is in this
  56.     way that User Supported Software will succeed.
  57.  
  58.  
  59.  
  60.  
  61.                     (2)        Registration
  62.                                ------------
  63.  
  64.          If you decide to use this program, cast your vote for User
  65.     Supported software by registering your use of the program.  Your
  66.     donation will help keep me writing useful quality software, and will
  67.     give you a good feeling inside.  ArcDoor is still expanding,
  68.     improvements and additions continue, but to keep on making these
  69.     improvements I need your support.
  70.  
  71.          Registered users will receive notices of new major versions of
  72.     ArcDoor (probably minor ones too) as well as any new products I write.  As
  73.     well, registered users gain prefered access to all the support I can give,
  74.     through conferencing on OASG - BBS, through mail and telephone.
  75.  
  76.          To register, send $30 in the form of a check or money order to the
  77.     following address:
  78.  
  79.                     Mark Cagley
  80.                     310 Dover Road
  81.                     Charlottesville, Va. 22901
  82.  
  83.          Along with this check or money order, include your name, address,
  84.     phone number, the name of the BBS you operate, and its phone number.
  85.  
  86.     IMPORTANT : Registration and payment for ArcDoor is mandatory!  If
  87.     after a two (2) week period you decide that it is worth its use on your
  88.     Bulletin Board System, register as explained above.  I hope that its
  89.     utilities will suit your needs, however - if not, please let me know
  90.     WHY you do not want to use it, and I will possibly try to remedy its
  91.     problem or missing feature.
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98. ----------------------------------------------------------------------------
  99.    Section [B]                 Description                  ArcDoor v1.00
  100. ----------------------------------------------------------------------------
  101.  
  102.  
  103.                     (1)     What is ArcDoor?
  104.                             ----------------
  105.  
  106.          ArcDoor is a "door" program that can be executed from a PCBoard
  107.     version 11+ Bulletin Board System that has the capability to run
  108.     "doors", or DOS shells.  When run from PCBoard, ArcDoor allows the user
  109.     to access the contents of the popular .ARC files used on most BBS's.  An
  110.     understanding of ARC is assumed, although not particularly necessary.
  111.     ArcDoor will allow any .ARC file in the areas specified by the SysOp to
  112.     be LISTED (a catalog of all files inside the ARChive), and any ASCII
  113.     file within the ARChive can be displayed.
  114.  
  115.          This is very helpful to a caller, because he no longer has to
  116.     download a file based on only a forty character description.  A
  117.     documentation, README, or other file inside the desired ARChive can be
  118.     read with ArcDoor prior to the actual download.  If the program does
  119.     not suit his needs or it is a version that he already owns (often the
  120.     descriptions do not even mention the version) he does not have to waste
  121.     time and possibly money downloading it.
  122.  
  123.  
  124.  
  125.  
  126.                     (2)          Features
  127.                                  --------
  128.  
  129.     o   Self-contained ARChive processing - ARC.EXE does NOT need to be
  130.         present on the disk, and "control" is never passed around different
  131.         programs - where a greater chance of errors AT THE DOS LEVEL could
  132.         occur.  ArcDoor is always in control after PCBoard starts it, and
  133.         it exits right back without complicated batch files.
  134.  
  135.     o   ArcDoor is a communications program!  It will access the COM port
  136.         directly, thus eliminating the need for CTTY.  (This means that the
  137.         user has NO control while the startup batch file is being
  138.         processed, also eliminating the need for PCBTRAP!) ArcDoor will
  139.         also sense Carrier Detect, taking the place of WATCHDOG (which
  140.         would boot the ENTIRE system, multi-nodes included) by exiting
  141.         gracefully back to the batch file that PCBoard executes if a user
  142.         hangs up while in ArcDoor.
  143.  
  144.           *--  No CTTY COMx
  145.           *--  No PCBTRAP
  146.           *--  No WATCHDOG
  147.  
  148.     o   Time is monitored within ArcDoor.  The SysOp can configure ArcDoor
  149.         for either a set time limit, or to use the PCBoard remaining time
  150.         of the user.  After the time limit expires, ArcDoor will pass the
  151.         user back to PCBoard.  If there is no keyboard activity in ArcDoor
  152.         for three minutes, the user will be passed back to PCBoard.
  153.  
  154.     o   ArcDoor will keep track of all activity of the users into a LOG
  155.         file.  It is specially designed to write to the PCBoard CALLERS
  156.         file, and give information showing what files are processed, any
  157.         error conditions, problems of the user, time spent in the door, and
  158.         many other situations encountered while in ArcDoor.  Printer
  159.         logging is also optional.  No longer does a display of the CALLERS
  160.         file not show any of the door activity.
  161.  
  162.     o   ArcDoor will read information about the user from the PCBOARD.SYS
  163.         file.  It detects the user's name, GRAPHICS mode, and optional time
  164.         remaining.  ANSI colors will be given to those who are in graphics
  165.         mode.
  166.  
  167.     o   ArcDoor contains on-line HELP.  A sample file included in this
  168.         ARChive can be modified by the SysOp (normal ASCII file) to be
  169.         displayed when the user selects the Help option.
  170.  
  171.     o   ArcDoor is safe.  As of this release, ArcDoor has NOT been
  172.         crashed - OR "LOCKED UP", as is possible with most other doors.
  173.         Even though a "door" is a shell to DOS, a SysOp can feel safe about
  174.         ArcDoor.  A user has only the control that ArcDoor gives him, he
  175.         cannot "break out" or lock up the system.
  176.         ***  We feel this is the most important feature... When a  ***
  177.         ***  program is operating near the DOS level, as with any  ***
  178.         ***  door, you cannot take chances.                        ***
  179.  
  180.     o   ArcDoor has been designed to be compatible with DoubleDOS and other
  181.         Multi-Taskers!  Not only because it does not use CTTY, but it also
  182.         performs BOTH input and output transmit buffers.  Other
  183.         communications programs tend to slow down considerably if another
  184.         communications program is running in the other partition of
  185.         DoubleDOS, as PCBoard is - but ArcDoor has fixed that problem.
  186.         Multi-node systems will hardly show a speed difference in ArcDoor!
  187.         Also - SHARE errors while PCBoard and ArcDoor access the same file
  188.         at the same time from different nodes are now handled with
  189.         appropriate messages.
  190.  
  191.     o   The local computer can operate ArcDoor!  While a user is inside
  192.         ArcDoor, BOTH he and the SysOp can perform the functions.  The
  193.         local keyboard operates along with the remote.  This could not be
  194.         accomplished with CTTY.
  195.  
  196.     o   With a configuration setting, ArcDoor can be run though a PCBoard
  197.         version 11.6+ in LOCAL mode.  This allows the SysOp to test ArcDoor
  198.         from the local computer.
  199.  
  200.  
  201.  
  202.  
  203.                     (3)       Requirements
  204.                               ------------
  205.  
  206.     o   A PCBoard 11.6+ Bulletin Board System with capability to execute
  207.         DOORs.  If PCBoard will run on your system, so should ArcDoor.
  208.  
  209.     NOTE : If not - please read Section [D] about how to contact me.
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216. ----------------------------------------------------------------------------
  217.    Section [C]                Installation                  ArcDoor v1.00
  218. ----------------------------------------------------------------------------
  219.  
  220.  
  221.                     (1)      Files involved
  222.                              --------------
  223.  
  224.          The files included in this ARChive are :
  225.  
  226.  
  227.     1.  ARCDOOR.COM   --   ArcDoor program.
  228.  
  229.     2.  ARCDOOR       --   Batch file to run ArcDoor (renamed to DOOR.BAT
  230.                            by PCBoard program.)
  231.  
  232.     3.  ARCDOOR.DAT   --   Sample configuration program for ArcDoor.
  233.                            Change with text editor.
  234.  
  235.     4.  WHATSNEW      --   Text file showing revision history.
  236.  
  237.     5.  ARCDOOR.DOC   --   This documentation.
  238.  
  239.  
  240.  
  241.  
  242.                     (2)       Setting Up
  243.                               ----------
  244.  
  245.     o  Use a text editor to change the ARCDOOR.DAT file to suit your
  246.        system.  The format for the file is :
  247.  
  248.        (see ARCDOOR.DAT in this ARChive for examples)
  249.  
  250.  
  251.     <line 1>      COM port for ArcDoor to communicate with.
  252.                   (either "COM1", "COM2", or "NONE" [for local testing])
  253.  
  254.     <line 2>      Number of minutes allowed per session in ArcDoor.
  255.                   (An entry of "PCB" will cause ArcDoor to pull the correct
  256.                   time remaining for the user from PCBoard.)
  257.  
  258.     <line 3>      Printer logging.  Use LPTx or NUL (for none)
  259.  
  260.     <line 4>      ArcDoor LOG file.  All activity within ArcDoor is written
  261.                   to this file.  It is fully compatible with CALLERS (or
  262.                   whatever you named it using PCBSETUP, screen #2, entry
  263.                   #2) and I strongly suggest you allow ArcDoor to use that
  264.                   file.  Give the path as configured with PCBSETUP.
  265.  
  266.     <line 5>      ArcDoor HELP file.  Drive, Path, and Filename of the file
  267.                   that you would like your users to see when selecting the
  268.                   "HELP" option from ArcDoor.  If this file does not exist,
  269.                   they will be told "Help file not available".
  270.                   No sample help file is included in this release, feel
  271.                   free to make one, and if possible, show it to us on
  272.                   OASG - BBS.  The best one will be included in future
  273.                   versions.
  274.  
  275.     <remaining    Valid download paths.  ArcDoor will look through these
  276.      lines>       paths to find the .ARC file requested by the user.
  277.                   (should be same as configured in PCBSETUP, screen #3,
  278.                   entry #7.) Please place only one drive:path on a line,
  279.                   and a trailing "\" is optional.  The current limit is 64
  280.                   lines.
  281.  
  282.     o  Note that the "ARCDOOR.DAT" filename MUST be specified on the
  283.        command line when calling ArcDoor.  Any filename can be used, thus
  284.        allowing multiple nodes to be configured differently.  Use the
  285.        format shown in ARCDOOR. included in this ARChive.
  286.  
  287.     o  Place ARCDOOR.DAT (filename configured above) in the PCBoard root
  288.        directory. (C:\PCBOARD\)
  289.  
  290.     o  Place ARCDOOR.COM in any subdirectory, as long as it is on your
  291.        current PATH set from DOS.
  292.  
  293.     o  Place ARCDOOR. in the PCBoard root directory.
  294.  
  295.     o  Add the line  "ArcDoor,<password>,<security level>"  to DOORS.DAT
  296.        (in path configured with PCBSETUP, the "main" directory)
  297.  
  298.     o  NOTE : The file ARCDOOR. does NOT contain WatchDog or CTTY!  ArcDoor
  299.        is now a communications program, and these are no longer necessary.
  300.        The local computer can now access the prompts the same as the
  301.        caller!  In other words, if the user is having a hard time, the
  302.        SysOp can type his commands. (as with PCBoard)
  303.  
  304.     o  There is no reason to have PCBTRAP resident.  The user is never
  305.        in control of the batch file, so CTRL codes do no harm.
  306.  
  307.     o  ***  ArcDoor should now be ready for use!  ***
  308.  
  309.     o  Either by changing line #1 of the configuration file to read "NONE"
  310.        or by adding the command line option "LOCAL" when calling the
  311.        program (e.g. ARCDOOR ARCDOOR.DAT LOCAL)  ArcDoor will run in
  312.        "local" mode, which means that Carrier Detect is not monitored, and
  313.        nothing will be sent out any COM port.  The SysOp can then test it.
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320. ----------------------------------------------------------------------------
  321.    Section [D]                  Help!!!                     ArcDoor v1.00
  322. ----------------------------------------------------------------------------
  323.  
  324.  
  325.          If you have any problems that this documentation does not explain,
  326.     please feel free to contact us for help.  We prefer you contact us
  327.     through our BBS, and quite often we will answer in person through your
  328.     BBS.
  329.  
  330.  
  331.               OASG - BBS     (John Gefaell - SysOp, Mark Cagley - Jr.SysOp)
  332.               (804) 924-4326
  333.               Charlottesville, Virginia
  334.  
  335.  
  336.          Upon verification (usually within 24 hours) we can discuss your
  337.     trouble in the SUPPORT conference.  Comments and suggestions are
  338.     welcome there also.  If you run ArcDoor, please don't be a stranger.
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345. ----------------------------------------------------------------------------
  346.    Section [E]            Planned Enhancements              ArcDoor v1.00
  347. ----------------------------------------------------------------------------
  348.  
  349.  
  350.     o   Configuration program to create the ARCDOOR.DAT file. This will
  351.         reduce the chances of configuration errors, and make it easier to
  352.         set up.
  353.  
  354.     o   Sense path data and other configuration information from the
  355.         PCBOARD.DAT and other PCBoard system files, eliminating need to
  356.         write out that information twice - for PCBoard and ArcDoor.
  357.  
  358.     o   A PCBoard-like directory lister.  ArcDoor implementation of the
  359.         [F], [L], and [Z] commands of PCBoard would allow a user to find
  360.         ARC files to process without having to exit ArcDoor or write them
  361.         down before entering.
  362.  
  363.     o   Conference and FSEC security.
  364.  
  365.     o   New versions of ArcDoor will be released, if possible, whenever
  366.         PCBoard upgrades include new features.
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373. ----------------------------------------------------------------------------
  374.    Section [F]                   Credits                    ArcDoor v1.00
  375. ----------------------------------------------------------------------------
  376.  
  377.  
  378.          ArcDoor has gone through many changes since its first creation.
  379.     Without the testing and implementation of ArcDoor by John Gefaell, it
  380.     would never have gotten far.  With his help, we tried to make it easy
  381.     to use, easy to implement, fast, and full-featured. Many thanks go to
  382.     John Gefaell and the Beta testers who helped with the testing and
  383.     features.  Here is a list of those involved who helped me design this
  384.     product.
  385.  
  386.          John Gefaell     - SysOp, OASG - BBS, Charlottesville, VA
  387.          Richard Driggers - SysOp, Sparta BBS, Sparta, NJ
  388.          Robert Blacher   - SysOp, Computer Connections BBS, Wash., DC
  389.          Paul Waldinger   - SysOp, The Sound of Music, Oceanside, NY
  390.          Bill Nolan       - SysOp, MINX, Wichita, KS
  391.  
  392.     and thanks also to :
  393.  
  394.          Philip Burns (PibTerm) for the basis of my communications
  395.            routines. (also Alan Bishop, C. J. Dunford, Michael Quinlan)
  396.          Bela Lubkin for the INT 24 handling.
  397.          Clark Development Company, Inc. for the most functional Bulletin
  398.            Board System available today in PCBoard, and their work and
  399.            continued efforts in providing code support for the
  400.            implementation of Doors.
  401.  
  402.  
  403.          John Gefaell and I are continuing DOOR work.  Not only is ArcDoor
  404.     still being revised, but new doors using the same COM port routines are
  405.     being processed.  Look for more door releases soon!  Included is a
  406.     joint effort with Marty Del Vecchio to develop a Script Processor door
  407.     for smart registrations, questionnaires, and many other uses.
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414. ----------------------------------------------------------------------------
  415.    Section [G]              Copyright Notice                ArcDoor v1.00
  416. ----------------------------------------------------------------------------
  417.  
  418.  
  419.          ArcDoor is Copyright (C) 1986 by Mark Cagley.  All rights are
  420.     reserved. The program is distributed under the User Supported software
  421.     concept. Non-registered users are allowed to use this program on a
  422.     trial basis for a limited time, and are allowed to give it to others so
  423.     that they may try it out as well. There are some restrictions:
  424.  
  425.          The program must be distributed in unmodified form, including
  426.          documentation. Any modification of the original form of the
  427.          program, including documentation, is illegal.
  428.  
  429.          The program must not be included with any other product for any
  430.          reason whatsoever.
  431.  
  432.          There can not be any fee charged for the program, in any form,
  433.          except for a disk handling fee of up to $5.00, which is allowed.
  434.  
  435.          If you have tried ArcDoor and intend to use it on your Bulletin
  436.     Board System, register as explained in Section [A] Part 2, and show
  437.     your support for the User Supported software concept.
  438.  
  439.  
  440.  
  441.  
  442.     *    ARC is Copyright 1985, 1986 by System Enhancement Associates.
  443.  
  444.     *    PCBoard is Copyright 1985, 1986 by Clark Development Company, Inc.
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451. ----------------------------------------------------------------------------
  452.                            ArcDoor v1.00
  453. ----------------------------------------------------------------------------
  454.  
  455.  
  456.     Please leave your (as well as your users)  comments, suggestions,
  457.     problems, etc. in messages to Mark Cagley or John Gefaell (SysOp)
  458.     on the OASG - BBS.  A SUPPORT conference has been set up for this
  459.     purpose.   I  will  address  the  problem/suggestion  as  soon as
  460.     possible and keep  you  updated  on  the  current ArcDoor version
  461.     through that conference.
  462.  
  463.     All revisions will be available first on OASG - BBS, and the Beta Test
  464.     BBS's. Minor revisions will most likely only be passed out through
  465.     Bulletin Boards, while registered users will also receive personal
  466.     notification of major changes.
  467.  
  468.  
  469.              ***    Thank you for your support!    ***
  470.  
  471.  
  472.            Mark Cagley                      Junior SysOp
  473.            310 Dover Road                   OASG - BBS
  474.            Charlottesville, Va. 22901       (804) 924-4326
  475.            (804) 973-3030
  476.  
  477.  
  478.  
  479.